fix(prefer-destructured-store-props): handle runes properly #1440
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: c3643d5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Try the Instant Preview in Online PlaygroundInstall the Instant Preview to Your LocalPublished Instant Preview Packages:
|
Copilot finished reviewing on behalf of
baseballyama
December 4, 2025 08:59
There was a problem hiding this comment.
Pull request overview
This PR fixes the prefer-destructured-store-props ESLint rule to properly handle Svelte 5 runes. The rule was incorrectly flagging rune member expressions (like $state.raw, $derived.by, $effect.pre) as stores that should be destructured. The fix adds logic to skip these Svelte 5 runes when the runes mode is enabled.
Key changes:
- Added
SVELTE_RUNESset containing Svelte 5 rune identifiers that should be excluded from store destructuring checks - Added conditional check to skip rune member expressions when
runes === true - Added test cases to verify runes are properly handled while actual stores are still caught
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/eslint-plugin-svelte/src/rules/prefer-destructured-store-props.ts | Core fix: imports getSvelteContext, defines SVELTE_RUNES set, and adds check to skip rune member expressions when runes are enabled |
| packages/eslint-plugin-svelte/tests/fixtures/rules/prefer-destructured-store-props/valid/runes01-input.svelte.js | Valid test case showing Svelte 5 rune usage in a class |
| packages/eslint-plugin-svelte/tests/fixtures/rules/prefer-destructured-store-props/valid/runes01-requirements.json | Specifies Svelte 5+ requirement for the valid test |
| packages/eslint-plugin-svelte/tests/fixtures/rules/prefer-destructured-store-props/invalid/runes-with-store01-input.svelte | Invalid test case verifying stores are still flagged when runes are present |
| packages/eslint-plugin-svelte/tests/fixtures/rules/prefer-destructured-store-props/invalid/runes-with-store01-requirements.json | Specifies Svelte 5+ requirement for the invalid test |
| packages/eslint-plugin-svelte/tests/fixtures/rules/prefer-destructured-store-props/invalid/runes-with-store01-errors.yaml | Expected error and autofix suggestion for the invalid test case |
| .changeset/wet-kiwis-cover.md | Changeset documenting the patch-level fix |
Comments suppressed due to low confidence (1)
packages/eslint-plugin-svelte/src/rules/prefer-destructured-store-props.ts:26
- The
SVELTE_RUNESset is missing$restProps, which is a built-in reactive variable in Svelte 5 that should also be excluded from this rule. When$restPropsis used (e.g.,{$restProps.foo}), it shouldn't be flagged for destructuring as it's a Svelte-managed reactive object, not a user-defined store.
Add '$restProps' to the set.
description:
'destructure values from object stores for better change tracking & fewer redraws',
category: 'Best Practices',
recommended: false
},
hasSuggestions: true,
schema: [],
messages: {
useDestructuring: `Destructure {{property}} from {{store}} for better change tracking & fewer redraws`,
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ota-meshi
approved these changes
Dec 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close: #1433